/*
 * Copyright 2008 the Breachwalls OSS project and the Others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package com.breachwalls.mogen.model;

import java.io.Serializable;
import java.util.List;

/**
 * モデル.
 * @author todoken
 * @version $Revision: 31 $
 */
public interface Model extends Serializable {

    /**
     * モデル自動生成モードを取得する.
     * @return モデル自動生成モード
     */
    GenerateMode getGenerateMode();

    /**
     * 親モデルを取得する.
     * @return 親モデル
     */
    Model getParent();

    /**
     * 親モデルを設定する.
     * @param model 親モデル
     */
    void setParent(Model model);

    /**
     * モデルのタイプを取得する.
     * @return モデルのタイプ
     */
    ModelType getModelType();

    /**
     * モデル名を取得する.
     * @return モデル名
     */
    String getName();

    /**
     * モデルの説明文を取得する.
     * @return モデルの説明文
     */
    String getDescription();

    /**
     * 抽象クラスかどうかを取得する.
     * @return 抽象クラスかどうか
     */
    boolean isAbstractClass();

    /**
     * モデルの継承元モデル名を取得する.
     * @return モデルの継承元モデル名
     */
    String getExtendsModelName();

    /**
     * モデルのフルクラス名を取得する.
     * @return モデルのフルクラス名
     */
    String getClassName();

    /**
     * モデルのプロパティ設定を取得する.
     * @return モデルのプロパティ設定
     */
    List<ModelProperty> getModelProperties();

    /**
     * モデルに設定されているフルクラス名のクラス名部分のみを取得する.
     * @return モデルのクラス名
     */
    String getShortClassName();

    /**
     * モデルに設定されているフルクラス名のパッケージ名部分のみを取得する.
     * @return モデルのパッケージ名
     */
    String getPackageName();

    /**
     * モデルに設定されている親モデルのフルクラス名を取得する.
     * @return 親モデルのフルクラス名
     */
    String getExtendsClassName();

    /**
     * モデルに設定されている親モデルのクラス名部分のみを取得する.
     * @return 親モデルのクラス名
     */
    String getExtendsShortClassName();

    /**
     * モデルに設定されている親モデルのパッケージ名部分のみを取得する.
     * @return 親モデルのパッケージ名
     */
    String getExtendsPackageName();

}
